Document! VB ships with HTML Help project template files that will create a standard 3 pane HTML Help window and create a standard table of contents and index. As you become more familar with authoring HTML Help, you may wish to adapt or replace these template files to customise the look and feel of the generated HTML Help file. You can specify the location of your custom templates in Stage 4 of the Document! VB Wizard.
The Document! VB template files are standard HTML Help Project (.hhp), Contents (.hhc) and Index (.hhk) files with placeholders for any variable items (such as project name or file lists). These placeholders are replaced with the correct values when Document! VB is run for a particular project.
The placeholders are identified by a leading and
trailing '%'. The default .hhp template file appears below as an
illustration.
As you can see, pretty much anything in the Project file can be altered, as long as the variable items such as ProjectName are taken account of.
Additional files to include can be inserted into the template contents (.hhc) file, such that the generated Document! VB contents can appear as a subset of a larger Help file.
Additional index entries can be inserted into the template index (.hhk) file, such that the generated Document! VB index entries can appear as part of a larger index.
The available placeholder names are as follows :
Project file (.hhp)
%ProjectName% | The Visual Basic Project Name |
%ProjectDescription% | The Project description as entered in the VB Project Properties dialog |
%Files% | Any files entries generated by Document! VB |
Contents file (.hhc)
%Contents%
Document VB generated contents
items
Index file (.hhk)
%Contents%
Document VB generated index
items